<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
<meta content="SequenceEventRaiser,net.digitalprimates.flex2.unit.sequence.SequenceEventRaiser,target,eventToBroadcast,timeout,timeoutHandler" name="keywords">
<title>net.digitalprimates.flex2.unit.sequence.SequenceEventRaiser</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'SequenceEventRaiser - AS3 FlexTest';
				var baseRef = '../../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Unit and Integration Framework for Actionscript 3 and Flex 2 and 3</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../index.html?net/digitalprimates/flex2/unit/sequence/SequenceEventRaiser.html&amp;net/digitalprimates/flex2/unit/sequence/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;SequenceEventRaiser</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class SequenceEventRaiser"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">net.digitalprimates.flex2.unit.sequence</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class SequenceEventRaiser</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td><a href="ISequenceAction.html">ISequenceAction</a></td>
</tr>
</table>
<p></p> 
  The sequencer event raiser class is used by the TestCase sequence 
  code to broadcast an event from a target. 
  
  It is generally used to simulate a user gesture, such as clicking on 
  a button. 
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#eventToBroadcast">eventToBroadcast</a> : Event<div class="summaryTableDescription">[read-only] 
   An event object which will be broadcast on the target.</div>
</td><td class="summaryTableOwnerCol">SequenceEventRaiser</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#target">target</a> : IEventDispatcher<div class="summaryTableDescription">[read-only] 
   The target event dispatcher where the eventToBroadcast will be 
   broadcast from.</div>
</td><td class="summaryTableOwnerCol">SequenceEventRaiser</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#timeout">timeout</a> : int<div class="summaryTableDescription">[read-only] 
   The number of milliseconds this class should wait for its handleEvent 
   method to be called, before firing a 'timerExpired' event.</div>
</td><td class="summaryTableOwnerCol">SequenceEventRaiser</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#timeoutHandler">timeoutHandler</a> : Function<div class="summaryTableDescription">[read-only] 
   <p>
   A reference to the event handler that should be called if the event named 
   in eventName does not fire before the timeout is reached.</div>
</td><td class="summaryTableOwnerCol">SequenceEventRaiser</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#SequenceEventRaiser()">SequenceEventRaiser</a>(broadcaster:EventDispatcher, eventToBroadcast:Event, timeout:int, timeoutHandler:Function = null)</div>
<div class="summaryTableDescription"> 
   Constructor.</div>
</td><td class="summaryTableOwnerCol">SequenceEventRaiser</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="eventToBroadcast"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">eventToBroadcast</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>eventToBroadcast:Event</code>&nbsp;&nbsp;[read-only]<p> 
   An event object which will be broadcast on the target. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get eventToBroadcast():Event</code>
<br>
</div>
<a name="target"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">target</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>target:IEventDispatcher</code>&nbsp;&nbsp;[read-only]<p> 
   The target event dispatcher where the eventToBroadcast will be 
   broadcast from.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get target():IEventDispatcher</code>
<br>
</div>
<a name="timeout"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">timeout</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>timeout:int</code>&nbsp;&nbsp;[read-only]<p> 
   The number of milliseconds this class should wait for its handleEvent 
   method to be called, before firing a 'timerExpired' event. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get timeout():int</code>
<br>
</div>
<a name="timeoutHandler"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">timeoutHandler</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>timeoutHandler:Function</code>&nbsp;&nbsp;[read-only]<p> 
   </p><p>
   A reference to the event handler that should be called if the event named 
   in eventName does not fire before the timeout is reached. </p>
   
   <p>
   The handler is expected to have the follow signature:</p>
   
   <p><code>
   public function handleTimeoutEvent( passThroughData:Object ):void {
   }</code></p>
   
   <p>
   The parameter is a generic object that can optionally be provided by the developer when starting
   a new asynchronous operation.
   <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get timeoutHandler():Function</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="SequenceEventRaiser()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">SequenceEventRaiser</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function SequenceEventRaiser(broadcaster:EventDispatcher, eventToBroadcast:Event, timeout:int, timeoutHandler:Function = null)</code><p> 
   Constructor.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">broadcaster</span>:EventDispatcher</code> &mdash; EventDispatcher, from which the event will be broadcast.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">eventToBroadcast</span>:Event</code> &mdash; An actual event, which will be broadcast from the target.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">timeout</span>:int</code> &mdash; The number of milliseconds to wait before calling the timoutHandler.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">timeoutHandler</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; Called if the timout is reached before the event is broadcast.
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">Copyright 2007 Digital Primates IT Consulting Group</center>
</div>
</body>
</html>
<!--Copyright 2007 Digital Primates IT Consulting Group-->
